/*
    * JBCS - A JBuilder Plugin for Checkstyle
    *
    * This program is free software; you can redistribute it and/or
    * modify it under the terms of the GNU General Public License
    * as published by the Free Software Foundation; either version 2
    * of the License, or (at your option) any later version.
    *
    * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   *
   * Copyright © 2003
   * Henri Tremblay
   */
  package com.henri.jbcs;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Iterator;
  import java.util.List;
  
  import javax.swing.Action;
  
  import com.borland.jbuilder.node.JBProject;
  import com.borland.jbuilder.node.JavaFileNode;
  import com.borland.jbuilder.node.PackageNode;
  import com.borland.primetime.ide.Browser;
  import com.borland.primetime.ide.BrowserAction;
  import com.borland.primetime.ide.ContextActionProvider;
  import com.borland.primetime.node.Node;
  
  /***
   * A BrowserAction to check multiple files.<p>
   *
   * The action spawns a thread for the checking, so that the message view can be
   * updated during a lengthy checking process.
   *
   * @author Henri Tremblay
   * @see BrowserAction
   * @see ContextActionProvider
   * @version $Revision: 1.6 $ $Date: 2005/08/01 20:48:47 $
   */
  public class CheckStyleContextAction extends BrowserAction implements ContextActionProvider
  {
     private Node[] m_nodes;
  
     /***
      * @see   BrowserAction
      */
     public CheckStyleContextAction() {
        super("Run Checkstyle", 'C',
           "Checkstyle is a development tool to help programmers write " +
           "Java code that adheres to a coding standard",
           CheckStyleOpenTool.ICON, "Run Checkstyle");
     }
  
     /***
      * Runs Checkstyle on all the <code>JavaFileNode</code> entries in the
      * m_Nodes array. If the array is null, get the active Node from the
      * browser.
      *
      * @param browser  The active browser.
      */
     public void actionPerformed(Browser browser) {
  
        if(m_nodes == null) {
           m_nodes = new Node[] {browser.getActiveNode()};
        }
  
        List fileList = new ArrayList();
        for(int i = 0; i < m_nodes.length; i++) {
           if(m_nodes[i] instanceof JavaFileNode) {
              if(!fileList.contains(m_nodes[i])) {
                 fileList.add(m_nodes[i]);
              }
           }
           else if(m_nodes[i] instanceof PackageNode) {
              processPackage(fileList, (PackageNode) m_nodes[i]);
           }
           else if(m_nodes[i] instanceof JBProject) {
              // Get all the nodes in the project & run them through this again.
              m_nodes = browser.getActiveProject().getDisplayChildren();
              // Filter the packages that are persistent since it means that they are not in the
              // project sources.
              for(int j = 0; j < m_nodes.length; j++) {
                 if(m_nodes[j] instanceof PackageNode && m_nodes[j].isPersistent()) {
                    m_nodes[j] = null; // Set to null so it won't be processed
                 }
              }
              this.actionPerformed(browser);
              return;
           }
        }
 
       JavaFileNode[] nodes = new JavaFileNode[fileList.size()];
       Iterator it = fileList.iterator();
       for(int i = 0; it.hasNext(); i++) {
          nodes[i] = (JavaFileNode) it.next();
       }
 
       CheckStyleOpenTool.checkNodes(browser, nodes);
 
       m_nodes = null;
    }
 
    private void processPackage(List fileList, PackageNode node) {
 
       // Add all the source files in the package.
       Node[] packageNodes = node.getDisplayChildren();
 
       // We retrieve it once (instead of doing it in isExcluded) only for performance reasons
       Collection exclusionPath = CheckStyleOpenTool.getPreference().getExclusionPath();
 
       for(int i = 0; i < packageNodes.length; i++) {
          if(packageNodes[i] instanceof JavaFileNode) {
             if(isExcluded(exclusionPath, ((JavaFileNode) packageNodes[i]).getUrl().getFullName())) {
                continue;
             }
             if(!fileList.contains(packageNodes[i])) {
                fileList.add(packageNodes[i]);
             }
          }
          else if(packageNodes[i] instanceof PackageNode && CheckStyleOpenTool.getPreference().getRecursive()) {
             processPackage(fileList, (PackageNode) packageNodes[i]);
          }
       }
 
    }
 
    private boolean isExcluded(Collection exclusionPath, String filePath) {
       for(Iterator it = exclusionPath.iterator(); it.hasNext();) {
          String path= (String) it.next();
          if(filePath.indexOf(path) > 0) {
             return true;
          }
       }
       return false;
    }
 
    /***
     * Sets the internal <code>Node[]</code> and return the Action if the first
     * entry is a source file, package node or project.
     *
     * @param browser  The active browser.
     * @param nodes    The active nodes.
     * @return         A reference to the static <code>CheckStyleOpenTool.ACTION_CheckStyleProject</code>
     *      action if the node is a source file, package node or project.
     * @see            ContextActionProvider
     */
    public Action getContextAction(Browser browser, Node[] nodes) {
       if(nodes.length == 0) {
          return null;
       }
       if(nodes[0] instanceof JBProject || nodes[0] instanceof JavaFileNode || nodes[0] instanceof PackageNode) {
          m_nodes = nodes;
          return this;
       }
       else {
          return null;
       }
    }
 }